Update and clean up JSDocs #38 #39
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Salil Cuncoliencar <Salil_Cuncoliencar@intuit.com>
nsinghal12
requested changes
Oct 30, 2022
| * @param {object} opt Is the option with the filePath or xmlContent and the optional format. | ||
| * @return {object} The pom object along with the timers. | ||
| * @param {*} opt Is the option with the filePath or xmlContent and the optional format. | ||
| * @param {*} callback The pom object along with the timers. |
There was a problem hiding this comment.
Fix up the leading text to param, and also use TS type.
| @@ -23,8 +23,8 @@ type ParseCallback=(e: Error | null, r?: ParsedOutput | null) => void; | |||
|
|
|||
| /** | |||
| * Parses xml into javascript object by using a file path or an xml content. | |||
| * @param {object} opt Is the option with the filePath or xmlContent and the optional format. | |||
| * @return {object} The pom object along with the timers. | |||
| * @param {*} opt Is the option with the filePath or xmlContent and the optional format. | |||
There was a problem hiding this comment.
Instead of * use the TS type here.
| @@ -103,6 +101,12 @@ function removeSingleArrays(obj: Object):void { | |||
| }); | |||
| } | |||
|
|
|||
| /** | |||
| * Reads a file in Async mode | |||
| * @param {*} path is the file path | |||
There was a problem hiding this comment.
Change type to string.
| /** | ||
| * Reads a file in Async mode | ||
| * @param {*} path is the file path | ||
| * @param {*} encoding is the type on encoding used in the file |
There was a problem hiding this comment.
Use correct type here.
| * Reads a file in Async mode | ||
| * @param {*} path is the file path | ||
| * @param {*} encoding is the type on encoding used in the file | ||
| * @returns |
| @@ -65,8 +65,6 @@ function parse(opt: ParseOptions,callback: ParseCallback): void { | |||
| /** | |||
| * Parses the given xml content. | |||
| * @param xmlContent {string} Is the xml content in string using utf-8 format. | |||
| * @param loadedXml {boolean} Whether the xml was loaded from the file-system. | |||
| * @param callback {function} The callback function using Javascript PCS. | |||
| */ | |||
| function _parseWithXml2js(xmlContent: string): Promise<ParsedOutput> { | |||
|
Closing stale PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.